home *** CD-ROM | disk | FTP | other *** search
/ LEGO Island 2 Rolling Demo / legoisland2.bin / Xtras / MpegXtra / MpegXtra Documentation.dxr / 00006_Field_Lingo Functions.txt < prev    next >
Text File  |  1999-01-12  |  3KB  |  49 lines
  1. Lingo Functions
  2.  
  3. MpegXtra┬« provides several functions that can be called from Lingo to control the playback of your Media files. 
  4.  
  5.  
  6. Cast Member Functions
  7.  
  8. addcuepoint(member x, cuepointtime, cuepointname) -- this function can be used to create a new cue point from Lingo. Cue points are automatically sorted for you.
  9. Example: addcuepoint(member 2, 10500, "NewCue")
  10.  
  11. removecuepoint(member x, cuepointindex) -- this function can be used to remove a cue point. You should supply the index of the cue point to be removed.
  12. Example: removecuepoint(member 2, 1)
  13.  
  14. getshortfilename(member x, longfilename) -- this function can be used to convert long filenames to short filenames, required by most MCI drivers.
  15. Example: getshortfilename(member 2, "C:\Program Files\file.mpg)
  16.         put the result
  17.        - "C:\PROGRA~1\FILE.MPG
  18.  
  19. scanfile(member x) -- this function can be used to extract the correct duration and dimensions of a video file when the linked media is changed via Lingo. The file is queried and the castmember properties are updated automatically. With MpegXtra 3.1 we introduced the adjustdurationbeforeplayback property, which also adjusts the duration, but does not impose and additional time penalty (the file is not opened twice), so it is generally better to leave it checked instead of using scanfile().
  20. Example: scanfile(member 2)
  21.  
  22. register(member x, registration number) -- this function can be used in Projectors to register MpegXtra at runtime, and allow developers to save linked casts. It is not necessary for the normal operation of the Xtra.
  23. Example: register(member 2, "SERIALNUMBERHERE")
  24.  
  25.  
  26. Sprite Functions
  27.  
  28. videoplay (sprite x) -- used to start or resume playback of a Media file. Playback is usually started automatically when the sprite is loaded, unless the "Paused at Start" option is checked.
  29. Example: videoplay(sprite 1)
  30.  
  31. videopause (sprite x) -- used to pause playback of a Media file. 
  32. Example: videopause(sprite 1)
  33.  
  34. videostop (sprite x) -- used to stop playback of a Media file. This is different from simply pausing, and some MPEG decoders require a full stop before a seek operation.
  35. Example: videostop(sprite 1)
  36.  
  37. videoseek (sprite x, time) -- seeks the video to a different time in the Media file, and pause the video. Time should be expressed in frames.
  38. Example: videoseek(sprite 1, 320)
  39.  
  40. videoplaysegment(sprite x, starttime, endtime) -- plays a segment of the Media file. 
  41. Example: videoplaysegment(sprite 1, 100,200)
  42.  
  43. videoplayfrom(sprite x, starttime) -- plays a the Media file starting from the point specified. 
  44. Example: videoplayfrom(sprite 1, 100)
  45.  
  46. isPastCuePoint(sprite x, cuepointindex) -- returns TRUE if the cue point indicated has already passed, FALSE otherwise.
  47. Example: isPastCuePoint(sprite 1,  2)
  48.               put the result
  49.              --- 1